---
id: get-lineage-events
title: "List all received OpenLineage events."
description: "Returns a list of OpenLineage events, sorted in direction of passed sort parameter. By default it is desc."
sidebar_label: "List all received OpenLineage events."
hide_title: true
hide_table_of_contents: true
api:
  {
    "operationId": "getLineageEvents",
    "parameters":
      [
        {
          "name": "sortDirection",
          "in": "query",
          "schema":
            {
              "type": "string",
              "example": "name",
              "description": "Sorts the results of your query by indicated direction `asc` or `desc`.",
            },
          "required": false,
        },
        {
          "name": "before",
          "in": "query",
          "description": "Returns events before passed date.",
          "required": false,
          "schema":
            {
              "type": "string",
              "format": "date-time",
              "example": "2022-09-15T07:47:19Z",
            },
        },
        {
          "name": "after",
          "in": "query",
          "description": "Returns events after passed date.",
          "required": false,
          "schema":
            {
              "type": "string",
              "format": "date-time",
              "example": "2022-09-15T07:47:19Z",
            },
        },
        {
          "name": "limit",
          "in": "query",
          "description": "The number of results to return from offset.",
          "required": false,
          "schema": { "type": "integer", "example": 25, "default": 100 },
        },
        {
          "name": "offset",
          "in": "query",
          "description": "The initial position from which to return results.",
          "required": false,
          "schema": { "type": "integer", "default": 0 },
        },
      ],
    "description": "Returns a list of OpenLineage events, sorted in direction of passed sort parameter. By default it is desc.",
    "tags": ["Events"],
    "responses":
      {
        "200":
          {
            "description": "OK",
            "content":
              {
                "application/json":
                  {
                    "schema":
                      {
                        "type": "object",
                        "properties":
                          {
                            "events":
                              {
                                "type": "array",
                                "items":
                                  {
                                    "example":
                                      {
                                        "eventType": "COMPLETE",
                                        "eventTime": "2019-05-09T19:49:24.201361Z",
                                        "run":
                                          {
                                            "runId": "d46e465b-d358-4d32-83d4-df660ff614dd",
                                          },
                                        "job":
                                          {
                                            "namespace": "my-namespace",
                                            "name": "my-job",
                                          },
                                        "outputs":
                                          [
                                            {
                                              "namespace": "my-namespace",
                                              "name": "my-output",
                                              "facets":
                                                {
                                                  "schema":
                                                    {
                                                      "_producer": "https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/client",
                                                      "_schemaURL": "https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/spec/OpenLineage.json#/definitions/SchemaDatasetFacet",
                                                      "fields":
                                                        [
                                                          {
                                                            "name": "a",
                                                            "type": "INTEGER",
                                                          },
                                                          {
                                                            "name": "b",
                                                            "type": "TIMESTAMP",
                                                          },
                                                          {
                                                            "name": "c",
                                                            "type": "INTEGER",
                                                          },
                                                          {
                                                            "name": "d",
                                                            "type": "INTEGER",
                                                          },
                                                        ],
                                                    },
                                                },
                                            },
                                          ],
                                        "producer": "https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/client",
                                      },
                                    "title": "LineageEvent",
                                  },
                              },
                            "totalCount":
                              {
                                "type": "number",
                                "description": "The total number of events returned matching our conditions.",
                              },
                          },
                        "title": "LineageEventList",
                      },
                  },
              },
          },
      },
    "method": "get",
    "path": "/events/lineage",
    "servers":
      [
        {
          "url": "http://localhost:5000/api/v1",
          "description": "Local API server",
        },
      ],
    "info":
      {
        "title": "Marquez",
        "version": "0.50.0",
        "description": "Marquez is an open source **metadata service** for the **collection**, **aggregation**, and **visualization** of a data ecosystem's metadata.",
        "license":
          {
            "name": "Apache 2.0",
            "url": "http://www.apache.org/licenses/LICENSE-2.0.html",
          },
      },
    "postman":
      {
        "name": "List all received OpenLineage events.",
        "description":
          {
            "content": "Returns a list of OpenLineage events, sorted in direction of passed sort parameter. By default it is desc.",
            "type": "text/plain",
          },
        "url":
          {
            "path": ["events", "lineage"],
            "host": ["{{baseUrl}}"],
            "query":
              [
                { "disabled": false, "key": "sortDirection", "value": "" },
                {
                  "disabled": false,
                  "description":
                    {
                      "content": "Returns events before passed date.",
                      "type": "text/plain",
                    },
                  "key": "before",
                  "value": "",
                },
                {
                  "disabled": false,
                  "description":
                    {
                      "content": "Returns events after passed date.",
                      "type": "text/plain",
                    },
                  "key": "after",
                  "value": "",
                },
                {
                  "disabled": false,
                  "description":
                    {
                      "content": "The number of results to return from offset.",
                      "type": "text/plain",
                    },
                  "key": "limit",
                  "value": "",
                },
                {
                  "disabled": false,
                  "description":
                    {
                      "content": "The initial position from which to return results.",
                      "type": "text/plain",
                    },
                  "key": "offset",
                  "value": "",
                },
              ],
            "variable": [],
          },
        "header": [{ "key": "Accept", "value": "application/json" }],
        "method": "GET",
      },
  }
sidebar_class_name: "get api-method"
info_path: docs/api/marquez
custom_edit_url: null
---

import ApiTabs from "@theme/ApiTabs";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import TabItem from "@theme/TabItem";

## List all received OpenLineage events.

Returns a list of OpenLineage events, sorted in direction of passed sort parameter. By default it is desc.

<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"sortDirection","in":"query","schema":{"type":"string","example":"name","description":"Sorts the results of your query by indicated direction `asc` or `desc`."},"required":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"before","in":"query","description":"Returns events before passed date.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-09-15T07:47:19Z"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"after","in":"query","description":"Returns events after passed date.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-09-15T07:47:19Z"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"The number of results to return from offset.","required":false,"schema":{"type":"integer","example":25,"default":100}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"offset","in":"query","description":"The initial position from which to return results.","required":false,"schema":{"type":"integer","default":0}}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

OK

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"events"} required={false} schemaName={"LineageEvent[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"example":{"eventType":"COMPLETE","eventTime":"2019-05-09T19:49:24.201361Z","run":{"runId":"d46e465b-d358-4d32-83d4-df660ff614dd"},"job":{"namespace":"my-namespace","name":"my-job"},"outputs":[{"namespace":"my-namespace","name":"my-output","facets":{"schema":{"_producer":"https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/client","_schemaURL":"https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/spec/OpenLineage.json#/definitions/SchemaDatasetFacet","fields":[{"name":"a","type":"INTEGER"},{"name":"b","type":"TIMESTAMP"},{"name":"c","type":"INTEGER"},{"name":"d","type":"INTEGER"}]}}}],"producer":"https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/client"},"title":"LineageEvent"}}}></SchemaItem><SchemaItem collapsible={false} name={"totalCount"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"The total number of events returned matching our conditions."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"events\": [\n    {\n      \"eventType\": \"COMPLETE\",\n      \"eventTime\": \"2019-05-09T19:49:24.201361Z\",\n      \"run\": {\n        \"runId\": \"d46e465b-d358-4d32-83d4-df660ff614dd\"\n      },\n      \"job\": {\n        \"namespace\": \"my-namespace\",\n        \"name\": \"my-job\"\n      },\n      \"outputs\": [\n        {\n          \"namespace\": \"my-namespace\",\n          \"name\": \"my-output\",\n          \"facets\": {\n            \"schema\": {\n              \"_producer\": \"https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/client\",\n              \"_schemaURL\": \"https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/spec/OpenLineage.json#/definitions/SchemaDatasetFacet\",\n              \"fields\": [\n                {\n                  \"name\": \"a\",\n                  \"type\": \"INTEGER\"\n                },\n                {\n                  \"name\": \"b\",\n                  \"type\": \"TIMESTAMP\"\n                },\n                {\n                  \"name\": \"c\",\n                  \"type\": \"INTEGER\"\n                },\n                {\n                  \"name\": \"d\",\n                  \"type\": \"INTEGER\"\n                }\n              ]\n            }\n          }\n        }\n      ],\n      \"producer\": \"https://github.com/OpenLineage/OpenLineage/blob/v1-0-0/client\"\n    }\n  ],\n  \"totalCount\": 0\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>

